home *** CD-ROM | disk | FTP | other *** search
/ Night Owl 6 / Night Owl's Shareware - PDSI-006 - Night Owl Corp (1990).iso / 033a / chknod12.zip / CHKNODES.DOC < prev    next >
Text File  |  1991-01-14  |  13KB  |  298 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.                                Check Nodes Version 1.0
  10.  
  11.                                   For PCBoard V14.x
  12.  
  13.  
  14.  
  15.  
  16.  
  17.                   Copyright (C) 1991 by Backland Computer Consulting
  18.                                  All Rights Reserved
  19.                                     
  20.                                     
  21.  
  22.  
  23.  
  24.  
  25.                 Backland Computer Consulting
  26.                 79 Elizabeth St.
  27.                 Barrie, Ontario
  28.                 CANADA
  29.                 L4N 6P4
  30.            
  31.                 Written by Brian Backland
  32.  
  33.                 Support BBS:
  34.                    Twilgiht Zone CIS
  35.                    Barrie, Ontario
  36.                    (705) 728-5815 via modem
  37.            
  38.         The author can be reached at the support BBS via modem or by sending
  39.         net mail.  NANet, InterNet, etc.
  40.  
  41.  
  42.  
  43.            PCBoard V14.x is a copyright of Clarke Development Company, Inc.
  44.  
  45.  
  46.  
  47.  
  48.  
  49.                                        LICENSE
  50.  
  51.                 Check Nodes V1.0 is not public domain software, nor is it free
  52.         software.  Check Nodes Version 1.0 is released as Shareware.  This
  53.         means try it before you buy it.  Check Nodes is copyright (C) 1991 by
  54.         Backland Computer Consulting.  Non-registered users are granted a
  55.         limited license to use Check Nodes V1.0 on a trial basis not to exceed
  56.         30 days, for the purpose of determining whether Check Nodes is
  57.         suitable for their needs.  
  58.  
  59.                 Use of Check Nodes, except for this limited purpose, requires
  60.         registration.  Registration permits a user the license to use
  61.         Check Nodes only on a single computer; a registered user may use the
  62.         program on a different computer, but may not use the program on more
  63.         than one computer at the same time.  
  64.  
  65.                 No user may modify Check Nodes in any way, including but not
  66.         limited to decompiling, disassembling or otherwise reverse engineering
  67.         the program.  All users are granted a limited license to copy
  68.         Check Nodes only for the trial use of others subject to the above
  69.         limitations, and also the following:
  70.  
  71.                 Check Nodes must be copied in unmodified form,
  72.                 complete with the file containing this license
  73.                 information.
  74.  
  75.                 The full Check Nodes documentation must be included
  76.                 with the copy.
  77.  
  78.                 No fee, charge or other compensation may be accepted
  79.                 or requested by any licensee.
  80.  
  81.                 Check Nodes may not be distributed in conjunction with
  82.                 any other product.
  83.  
  84.                 Operators of electronic bulletin board systems (Sysops) may
  85.         post Check Nodes for downloading by their users only as long as the
  86.         above conditions are met.
  87.  
  88.                 Distributors of public domain or user supported software may
  89.         distribute copies of Check Nodes subject to the above conditions only
  90.         after obtaining written permission from Backland Computer Consulting. 
  91.         Such permission usually is granted; please write for details.
  92.  
  93.  
  94.  
  95.  
  96.  
  97.                                        WARRANTY
  98.  
  99.                 Backland Computer Consulting makes no warranty of any kind,
  100.         express or implied, including without limitation, any warranties of
  101.         merchantability and/or fitness for a particular purpose.  Backland
  102.         Computer Consulting shall not be liable for any damages, whether
  103.         direct, indirect, special or consequential arising from a failure of
  104.         this program to operate in the manner desired by the user.  Backland
  105.         Computer Consulting shall not be liable for any damage to data or
  106.         property which may be caused directly or indirectly by use of the
  107.         program.
  108.  
  109.                 IN NO EVENT WILL Backland Computer Consulting BE LIABLE TO YOU
  110.         FOR ANY DAMAGES, INCLUDING ANY LOST PROFITS, LOST SAVINGS OR OTHER
  111.         INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF YOUR USE OR
  112.         INABILITY TO USE THE PROGRAM, OR FOR ANY CLAIM BY ANY OTHER PARTY.
  113.  
  114.  
  115.                                    ACKNOWLEDGEMENTS
  116.  
  117.                 Check Nodes is a concept of Robin Wells, the Chief Sysop of
  118.         the Twilight Zone CIS.
  119.  
  120.  
  121.  
  122.  
  123.  
  124.                                        OVERVIEW
  125.  
  126.                 Check Nodes is a third party product for PCBoard Version 14.x
  127.         intended for use in a multi-node configuration.  Check Nodes was
  128.         developed to enable the Sysop of a PCBoard V14.x BBS to check the
  129.         status of the nodes during an event.  Some third party software
  130.         packages have been known to crash (lock-up) the computer when one or
  131.         more nodes is still up.  Check Nodes will, as the name implies, check
  132.         the PCBoard nodes and report in DOS ERRORLEVEL two conditions:
  133.                 1) one or more of the nodes are still up, or 
  134.                 2) all nodes are down.
  135.         No configuration of Check Nodes is required, as it obtains its
  136.         information about your PCBoard BBS from the PCBoard system files.
  137.  
  138.  
  139.                                       OPERATION
  140.  
  141.                 To use Check Nodes, copy the CHKNODES.EXE file to any
  142.         sub-directory in your DOS path.  When running Check Nodes ensure your
  143.         default sub-directory is set to the sub-directory that contains the
  144.         PCBoard system file PCBOARD.DAT, otherwise it won't be able to read
  145.         your PCBoard BBS configuration, and will return an error.  Check Nodes
  146.         will not search the PATH or other environment variables for
  147.         PCBOARD.DAT.  In your event batch file, insert a line to call the
  148.         Check Nodes executable file with the desired switch, if applicable. 
  149.         Then simply check the DOS ERRORLEVEL value returned by Check Nodes to
  150.         discover the status of the nodes.
  151.  
  152.  
  153.                                        SWITCHES
  154.  
  155.                 Although no switches are required to run Check Nodes, there
  156.         are three available to you.  You may not specify more than one switch
  157.         at the a time, if you do Check Nodes will report an error.  If you run
  158.         Check Nodes without a switch it will check the status of the nodes and
  159.         return that information to you immediately.  The switches are not case
  160.         dependant, therefore you may enter them in uppercase or lowercase.  
  161.  
  162.                 The /T:<minutes> switch allows you to specify the number of
  163.         minutes you want Check Nodes to continually check the nodes, if it
  164.         finds that one or more nodes is still up.  To use this switch replace
  165.         the <minutes> with a numeric value representing the number of minutes
  166.         you want to monitor the nodes.  Don't forget the colon between the T
  167.         and the number.
  168.  
  169.                 For example:  CHKNODES /T:5
  170.  
  171.         Check Nodes will continually monitor the nodes during the delay and
  172.         will display a timer showing the elapsed time.  After the specified
  173.         number of minutes expires (5 in this case) or after all nodes are
  174.         down, whichever comes first, Check Nodes will return the status of the
  175.         nodes in the DOS ERRORLEVEL.  To abort before the timer expires press
  176.         the ESC (escape) key and Check Nodes will pass control back to your
  177.         event batch file, the DOS ERRORLEVEL will contain the appropriate code
  178.         to the status of the nodes.  The valid range of this switch is from 1
  179.         to 1440.  It will not accept 0 or a number greater than 1440.  This
  180.         allows you to specify a delay ranging from 1 minute to 24 hours.
  181.  
  182.  
  183.  
  184.  
  185.  
  186.                 The /W switch allows you to specify an indefinite delay. 
  187.         Check Nodes will continually monitor the nodes, and will return the
  188.         status of the nodes in the DOS ERRORLEVEL once all nodes are down. 
  189.         The timer will NOT be displayed.  You can abort this indefinite delay
  190.         by pressing the ESC (escape) key, Check Nodes will pass control back
  191.         to your event batch file with the appropriate status code in the DOS
  192.         ERRORLEVEL.
  193.  
  194.                 Another switch ? or /? may be used to display the quick help
  195.         screen.  The nodes will not be checked for their status.  Note that
  196.         the value returned in DOS ERRORLEVEL will reflect an error when this
  197.         switch is used.
  198.  
  199.  
  200.                                      RETURN CODES
  201.  
  202.                 Check Nodes returns the status of the nodes in the DOS
  203.         ERRORLEVEL.  If all nodes are down ERRORLEVEL will be set to 0. If it
  204.         finds one or more nodes still up ERRORLEVEL will be set to 1.  If an
  205.         error occurs while running Check Nodes ERRORLEVEL will be set to 2. 
  206.         Consult your DOS manual for information on how to check the
  207.         ERRORLEVEL.
  208.  
  209.                 ERRORLEVEL       Description
  210.                 ----------       ---------------------------------
  211.                    0             All nodes are down.
  212.                    1             One or more nodes are still up.
  213.                    2             An error has occurred.
  214.  
  215.         Errors that cause an ERRORLEVEL 2 are:
  216.                 - more than one switch was specified, only specify one switch.
  217.                 - couldn't locate PCBOARD.DAT in current sub-directory, ensure
  218.                    PCBOARD.DAT is in current sub-directory.
  219.                 - number of mintues in switch /T: was 0 or greater than 1440,
  220.                    specify a number of minutes in the range 1 to 1440.
  221.                 - you asked for the quick help screen with switch /? or ?
  222.                    not a true error, but it doesn't check the nodes when you
  223.                    specify this switch.
  224.  
  225.  
  226.  
  227.  
  228.  
  229.                                    QUICK REFERENCE
  230.  
  231.         CHKNODES [/T:<minutes>] [/W] [? or /?]
  232.            where: /T:<minutes> - number of minutes to keep checking,
  233.                                     may range from 1 to 1440.
  234.                   /W           - keep checking indefinitely.
  235.                   ? or /?      - displays the quick help screen.
  236.  
  237.            returns in DOS's ERRORLEVEL():
  238.               0 = all nodes are down
  239.               1 = one or more nodes are not down
  240.               2 = an error has occurred
  241.  
  242.         NOTE: - You may only specify one or no switch.
  243.               - Use ESC to abort a delay caused by a switch.
  244.  
  245.  
  246.  
  247.  
  248.  
  249.                                      REGISTRATION
  250.  
  251.         A registration fee of $15.00 Cdn or US is requested by all users of
  252.         Check Nodes V1.0.  To register your copy of Check Nodes simply fill
  253.         out the form below and mail it to the address on the form along with
  254.         your cheque or money order.  All cheques or money orders must be
  255.         payable to Backland Computer Consulting.
  256.  
  257.          ----------------  Check Nodes Registration Form  -------------------
  258.                    Please support shareware with your registration.
  259.         Name    
  260.         _____________________________________________________________________ 
  261.  
  262.         Address 
  263.         _____________________________________________________________________
  264.                 
  265.         _____________________________________________________________________
  266.  
  267.         [  ] Cheque or Money Order payable to Backland Computer Consulting
  268.  
  269.                 ____ Check Nodes V1.0 Registration(s)  $15.00    ________
  270.                 ____ Ontario Provicial Sales Tax 8%     $1.20    ________
  271.                         (Ontario residents only)
  272.                 ____ Goods and Services Tax 7%          $1.05    ________
  273.                         (Canada residents only)
  274.                                                          Total   ________
  275.  
  276.                              Thank you for your support.
  277.  
  278.              --------------------  INSTANT MAILER  ----------------------
  279.  
  280.         Fold at the page break below with the printing facing out.  Then fold
  281.         letter style, exposing the mailing address and hiding your
  282.         information.  If necessary, staple check to the mailer, then staple or
  283.         tape sides and top.
  284.         ----------------------------------------------------------------------
  285.         _________________________________                            Place
  286.  
  287.         _________________________________                            Stamp
  288.  
  289.         _________________________________                            Here
  290.  
  291.  
  292.                                                  Backland Computer Consulting
  293.                                                  79 Elizabeth St.
  294.                                                  Barrie, Ontario
  295.                                                  CANADA
  296.                                                  L4N 6P4
  297.         Check Nodes V1.0
  298.